Tootsville::Endpoint-Post-/ Users/ Me/ Play-With/ Toot-Name→Json

Function

Endpoint-Post-/ Users/ Me/ Play-With/ Toot-Name→Json names a function, with lambda list (TOOT-NAME):

Begin playing with the Toot named TOOT-NAME.

Toot-Name
The name of the Toot character to play with.

Status: 200 OK

You are now in control of this Toot. The Toot's info will be returned.

The returned body will be a JSON object with two keys;

toot
The Toot avatar information as returned by TOOTSVILLE TOOT-INFO.
player
The player information returned by TOOTSVILLE PERSON-INFO.

Status: 401 Authorization Required

No user credentials were passed.

Status: 403 Authorization Failed

The user credentials presented were not recognized.

Status: 404 Not Found

The Toot named does not exist.

Status: 405 Not Allowed

The Toot named is one that you have permission to use, but are not the main owner of. This is usually a child account.

Web Service Endpoint

This is a web service endpoint accessed by the HTTP method POST at the URI template /users/me/play-with/:toot-name. It returns a content-type of application/json.

TOOT-NAME is a parameter from the URI.

It will report a slow response if it takes longer than 0.03 seconds (30 milliseconds) to complete.

File

Defined in file src/endpoints/slash-users.lisp.